<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: cy_stc_hppass_sar_grp_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structcy__stc__hppass__sar__grp__t.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">cy_stc_hppass_sar_grp_t Struct Reference<div class="ingroups"><a class="el" href="group__group__hppass.html">HPPASS       (High Performance Programmable Analog Sub-System)</a> &raquo; <a class="el" href="group__group__hppass__sar.html">SAR (Successive-Approximation Register Analogue to Digital Converter)</a> &raquo; <a class="el" href="group__group__hppass__sar__data__structures.html">Data Structures</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>The SAR Sequencer Table Entry configuration structure. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a352c1fe5740afb64945f0f04dc707a0a"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__hppass__sar__grp__t.html#a352c1fe5740afb64945f0f04dc707a0a">dirSampMsk</a></td></tr>
<tr class="memdesc:a352c1fe5740afb64945f0f04dc707a0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Direct samplers enable mask, each bit corresponds to one of the 12 direct samplers.  <a href="#a352c1fe5740afb64945f0f04dc707a0a">More...</a><br /></td></tr>
<tr class="separator:a352c1fe5740afb64945f0f04dc707a0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfe76d676afdd58ab72ec1c58fd40088"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__hppass__sar__grp__t.html#abfe76d676afdd58ab72ec1c58fd40088">muxSampMsk</a></td></tr>
<tr class="memdesc:abfe76d676afdd58ab72ec1c58fd40088"><td class="mdescLeft">&#160;</td><td class="mdescRight">Muxed samplers enable mask, each bit corresponds to one of the 4 muxed samplers.  <a href="#abfe76d676afdd58ab72ec1c58fd40088">More...</a><br /></td></tr>
<tr class="separator:abfe76d676afdd58ab72ec1c58fd40088"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae88477c8b8546015632e7e592c03de0f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__hppass__sar__grp__t.html#ae88477c8b8546015632e7e592c03de0f">muxChanIdx</a> [<a class="el" href="group__group__hppass__macros.html#ga84078bbc58368ae5f42f4daf39c5243d">CY_HPPASS_SAR_MUX_NUM</a>]</td></tr>
<tr class="memdesc:ae88477c8b8546015632e7e592c03de0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Muxed Sampler Channel selection for sampler 12, 13, 14 and 15.  <a href="#ae88477c8b8546015632e7e592c03de0f">More...</a><br /></td></tr>
<tr class="separator:ae88477c8b8546015632e7e592c03de0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2118533527535486039eeae9af3161c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__hppass__sar__enums.html#gafb345a3d451274c4b40309384dd07efc">cy_en_hppass_sar_trig_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__hppass__sar__grp__t.html#a2118533527535486039eeae9af3161c0">trig</a></td></tr>
<tr class="memdesc:a2118533527535486039eeae9af3161c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Input Trigger selection.  <a href="#a2118533527535486039eeae9af3161c0">More...</a><br /></td></tr>
<tr class="separator:a2118533527535486039eeae9af3161c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6a2244179df1a1e5afa556a27742bfa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__hppass__sar__enums.html#gaffa59d1aa8d36df32dca30f0afed2e0f">cy_en_hppass_sar_samp_time_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__hppass__sar__grp__t.html#ad6a2244179df1a1e5afa556a27742bfa">sampTime</a></td></tr>
<tr class="memdesc:ad6a2244179df1a1e5afa556a27742bfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sampling Timer Selection.  <a href="#ad6a2244179df1a1e5afa556a27742bfa">More...</a><br /></td></tr>
<tr class="separator:ad6a2244179df1a1e5afa556a27742bfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a685aff5658b9e005f5ad856a1468145e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__hppass__sar__grp__t.html#a685aff5658b9e005f5ad856a1468145e">priority</a></td></tr>
<tr class="memdesc:a685aff5658b9e005f5ad856a1468145e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Priority: false - low priority, true - high priority If the application configures a combination of high and low priority entries, depending on the usage demand on the SAR from High Priority Entries, a Low Priority Entry might stay in HOLD state beyond a specified limit, set by <a class="el" href="group__group__hppass__sar__functions.html#ga9fd436201ef4ead2ec1083f83c8feff4">Cy_HPPASS_SAR_SetHoldViolationCnt</a> function.  <a href="#a685aff5658b9e005f5ad856a1468145e">More...</a><br /></td></tr>
<tr class="separator:a685aff5658b9e005f5ad856a1468145e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aace0ee2f74f2ba483dcf12f6e6796788"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__hppass__sar__grp__t.html#aace0ee2f74f2ba483dcf12f6e6796788">continuous</a></td></tr>
<tr class="memdesc:aace0ee2f74f2ba483dcf12f6e6796788"><td class="mdescLeft">&#160;</td><td class="mdescRight">Continuous mode.  <a href="#aace0ee2f74f2ba483dcf12f6e6796788">More...</a><br /></td></tr>
<tr class="separator:aace0ee2f74f2ba483dcf12f6e6796788"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="a352c1fe5740afb64945f0f04dc707a0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a352c1fe5740afb64945f0f04dc707a0a">&#9670;&nbsp;</a></span>dirSampMsk</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint16_t cy_stc_hppass_sar_grp_t::dirSampMsk</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Direct samplers enable mask, each bit corresponds to one of the 12 direct samplers. </p>
<p>Zero bit of this mask corresponds to sampler 0, first bit to sampler 1 and so on. Bits 12 to 15 are not used. When this Entry is triggered, any samplers with a bit set to '1' will be simultaneously sampled, held, and then converted. There is a 1-1 correspondence between these 12 samplers and the first 12 result channels. SAR results can be read using <a class="el" href="group__group__hppass__sar__chan.html#gaea7bbb3947dc53f845f8f4955d678187">Cy_HPPASS_SAR_Result_ChannelRead</a> with corresponding channel index. </p>

</div>
</div>
<a id="abfe76d676afdd58ab72ec1c58fd40088"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfe76d676afdd58ab72ec1c58fd40088">&#9670;&nbsp;</a></span>muxSampMsk</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t cy_stc_hppass_sar_grp_t::muxSampMsk</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Muxed samplers enable mask, each bit corresponds to one of the 4 muxed samplers. </p>
<p>Zero bit of this mask corresponds to sampler 0, first bit to sampler 1 and so on. Bits 4 to 7 are not used. When this Entry is triggered, any samplers with a bit set to '1' will be simultaneously sampled, held, and then converted. Each one of these samplers maps to 4 result channels as determined by the mux setting 0, 1, 2, or 3 in order, using <a class="el" href="structcy__stc__hppass__sar__grp__t.html#ae88477c8b8546015632e7e592c03de0f" title="Muxed Sampler Channel selection for sampler 12, 13, 14 and 15. ">cy_stc_hppass_sar_grp_t::muxChanIdx</a> field. The mapping is:</p><ul>
<li>bit 0 (sampler 12) can sample 12, 13, 14, 15 channels</li>
<li>bit 1 (sampler 13) can sample 16, 17, 18, 19 channels</li>
<li>bit 2 (sampler 14) can sample 20, 21, 22, 23 channels</li>
<li>bit 3 (sampler 15) can sample 24, 25, 26, 27 channels</li>
</ul>
<p>SAR results can be read using <a class="el" href="group__group__hppass__sar__chan.html#gaea7bbb3947dc53f845f8f4955d678187">Cy_HPPASS_SAR_Result_ChannelRead</a> with corresponding channel index. </p>

</div>
</div>
<a id="ae88477c8b8546015632e7e592c03de0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae88477c8b8546015632e7e592c03de0f">&#9670;&nbsp;</a></span>muxChanIdx</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t cy_stc_hppass_sar_grp_t::muxChanIdx[<a class="el" href="group__group__hppass__macros.html#ga84078bbc58368ae5f42f4daf39c5243d">CY_HPPASS_SAR_MUX_NUM</a>]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Muxed Sampler Channel selection for sampler 12, 13, 14 and 15. </p>
<p>Valid Range: 0...3 Effective only if the correspondent <a class="el" href="structcy__stc__hppass__sar__t.html#a4119fc3ea6c77c62bef5161c37eec951">cy_stc_hppass_sar_t::muxMode</a> == <a class="el" href="group__group__hppass__sar__enums.html#ggab8d45f2bf082e466df16caed456b727aa80cd4f6f2903e96a0f035e463a0c4b3c">CY_HPPASS_SAR_MUX_SEQ</a> (the default option), otherwise ignored. </p>

</div>
</div>
<a id="a2118533527535486039eeae9af3161c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2118533527535486039eeae9af3161c0">&#9670;&nbsp;</a></span>trig</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__hppass__sar__enums.html#gafb345a3d451274c4b40309384dd07efc">cy_en_hppass_sar_trig_t</a> cy_stc_hppass_sar_grp_t::trig</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Input Trigger selection. </p>
<p>Pulse and Level triggers may be used. When the Level trigger is used, trigger event is on the rising edge of the trigger. </p>

</div>
</div>
<a id="ad6a2244179df1a1e5afa556a27742bfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6a2244179df1a1e5afa556a27742bfa">&#9670;&nbsp;</a></span>sampTime</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__hppass__sar__enums.html#gaffa59d1aa8d36df32dca30f0afed2e0f">cy_en_hppass_sar_samp_time_t</a> cy_stc_hppass_sar_grp_t::sampTime</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sampling Timer Selection. </p>
<p>Choose one out of four available Sample Timers: <a class="el" href="structcy__stc__hppass__sar__t.html#ad1fbfb3380623a4fd0ec5acaad02f9cb">cy_stc_hppass_sar_t::sampTime</a> </p>

</div>
</div>
<a id="a685aff5658b9e005f5ad856a1468145e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a685aff5658b9e005f5ad856a1468145e">&#9670;&nbsp;</a></span>priority</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool cy_stc_hppass_sar_grp_t::priority</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Priority: false - low priority, true - high priority If the application configures a combination of high and low priority entries, depending on the usage demand on the SAR from High Priority Entries, a Low Priority Entry might stay in HOLD state beyond a specified limit, set by <a class="el" href="group__group__hppass__sar__functions.html#ga9fd436201ef4ead2ec1083f83c8feff4">Cy_HPPASS_SAR_SetHoldViolationCnt</a> function. </p>
<p>To ensure that the Low Priority Entry did not stay in HOLD state beyond this limit, before reading a Low Priority Entry result, check the <a class="el" href="group__group__hppass__sar__functions.html#ga0452cda79fe2df67fdf19b967975158a">Cy_HPPASS_SAR_GetHoldViolationStatus</a> function status to ensure that the result is within spec. Refer to device TRM for more details. </p>

</div>
</div>
<a id="aace0ee2f74f2ba483dcf12f6e6796788"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aace0ee2f74f2ba483dcf12f6e6796788">&#9670;&nbsp;</a></span>continuous</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool cy_stc_hppass_sar_grp_t::continuous</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Continuous mode. </p>
<p>If true - this entry will automatically be re-triggered when the current conversion of all channels in this entry has been completed. In general a continuous Entry should have additional sample time (<a class="el" href="structcy__stc__hppass__sar__grp__t.html#ad6a2244179df1a1e5afa556a27742bfa" title="Sampling Timer Selection. ">cy_stc_hppass_sar_grp_t::sampTime</a> is not <a class="el" href="group__group__hppass__sar__enums.html#ggaffa59d1aa8d36df32dca30f0afed2e0fa456ddeae16d805a7a01e9cbc78187f05">CY_HPPASS_SAR_SAMP_TIME_DISABLED</a>), otherwise this Entry will be continuously triggered and use the majority of the SAR performance bandwidth. Sample time is the only way to set the period of a continuous Entry. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
